SakuraFrp 启动器安装 / 使用指南

您所在的位置:网站首页 隧道下载 下载 SakuraFrp 启动器安装 / 使用指南

SakuraFrp 启动器安装 / 使用指南

2023-11-18 12:46| 来源: 网络整理| 查看: 265

# SakuraFrp 启动器安装 / 使用指南# 下载启动器这一节非常简单,推荐您直接跳过 (点击展开)

登录管理面板,转到 软件下载 页面:

选择正确的平台与架构,然后点击右侧下载按钮下载启动器安装程序:

# 安装启动器

提示

如果在安装过程中碰到问题,请参阅 启动器常见安装问题 常见问题大多与 .NET Framework 有关,可以尝试先装好 .NET Framework 4.8 再安装启动器高级用户 也可以选择不装用户界面,使用 Web UI(配置复杂,仅限高级用户)

运行安装程序并根据向导提示进行安装,通常情况下一直点 下一步 即可。

默认组件适合大部分用户使用,您也可以参考下图选择需要安装的组件:

# 关于开机启动

如果需要不登录 Windows 就自启(例如穿透远程桌面服务),请参阅 系统服务 页面了解服务启动方式。

否则在大多数情况下,直接打开启动器设置里的开关就能满足使用需求:

打开下载的 .dmg 文件,然后按箭头指示将启动器拖到 Applications 文件夹中即可:

# 关于开机启动

如果需要在启动时自动打开用户界面,请参考 Apple 帮助文档:Mac 启动时自动打开应用在新窗口打开

如果只需要启动隧道、不显示用户界面,请打开下图所示的开关:

提示

这篇指南适合普通 Linux 桌面用户,希望在 自己登录桌面后,桌面注销前 使用映射服务的情况 如果您需要服务在开机后总是可用,或者使用 root 账户,请查看 Linux 服务器 标签

出于安全考虑,natfrp-service 默认不允许以 root 权限运行,我们也推荐您不要使用 root 用户登录桌面环境

请留意当前账户

以下指南基于您正在使用 非 root 账户登录桌面环境,且 shell 中不是 root 账户 如果您正在使用 root 账户且决定一直使用 root 账户,您应该可以自己解决问题

由我们分发的压缩包采用 zstd在新窗口打开 进行压缩,如果您还没有 zstd,请先在系统上安装。

下载由我们分发的 .tar.zst 文件后,在合适的地方建一个文件夹并解压 natfrp-service 与 frpc:

# 创建文件夹,例如 ~/.config/natfrp/ (只是举个例子) mkdir -p ~/.config/natfrp/ cd ~/.config/natfrp/ # 复制对应的下载链接并下载 # curl -LO https://.... # 解压 tar -I zstd -xvf natfrp-service_*.tar.zst rm natfrp-service_*.tar.zst # 设置权限 chmod +x frpc natfrp-service

运行 ./natfrp-service webui --init 初始化配置文件,此时浏览器应该会自动打开。

如果没有看到浏览器请手动点击安装 URL,安装 URL 包含您的 启动器连接密码,请注意不要泄露:

然后先把浏览器放到一边,参考发行版的相关教程配置您的初始化系统来启动 natfrp-service --daemon。

以 Systemd 为例,在用户文件夹建立一个 Unit 文件即可。如果需要进行高级配置请参考 启动器用户手册。

这是一个简单的示例文件,您可以直接把它复制到 ~/.config/systemd/user/natfrp.service:

[Unit] Description=SakuraFrp Launcher After=network.target [Service] Type=simple TimeoutStopSec=20 Restart=always RestartSec=5s ExecStart=%h/.config/natfrp/natfrp-service --daemon [Install] WantedBy=default.target

让初始化系统拉起启动器进程并确认启动器在运行,这里还是以 Systemd 为例:

systemctl --user enable --now natfrp.service systemctl --user status natfrp.service

现在回到浏览器,安装 PWA 并点击下面的继续按钮。

如果您使用的是 Chromium,可以参考下图操作:

由于 Firefox 不支持 PWA,直接刷新一下就行了,什么都不需要点,然后就能看到启动器的 Web UI:

这样启动器就安装完成了,并且会在登录时自动启动。您随时可以打开 Web UI 进行管理。

提示

这篇指南假设您以 root 权限进行安装,若您使用其他用户请使用 sudo -i 或 su - 切换到 root 账户执行特权指令

由我们分发的压缩包采用 zstd在新窗口打开 进行压缩,如果您还没有 zstd,请先在系统上安装。

出于安全考虑,natfrp-service 默认不允许以 root 权限运行,创建一个新账户:

useradd -r -m -s /sbin/nologin natfrp

下载由我们分发的 .tar.zst 文件,将其安装到系统中:

# 您可以将其安装到任意目录,这里直接装到 HOME 是为了简化操作 # 对路径出警的 Issue 或 PR 可能不会得到处理 cd /home/natfrp/ # 复制对应的下载链接并下载 # curl -LO https://.... # 解压 tar -I zstd -xvf natfrp-service_*.tar.zst rm natfrp-service_*.tar.zst # 设置权限 chmod +x frpc natfrp-service chown natfrp:natfrp frpc natfrp-service

参考发行版的相关教程配置您的初始化系统来启动 natfrp-service --daemon。

以 Systemd 为例,建立一个 Unit 文件即可。如果需要进行高级配置请参考 启动器用户手册。

这是一个简单的示例文件,您可以直接把它复制到 /etc/systemd/system/natfrp.service:

[Unit] Description=SakuraFrp Launcher After=network.target [Service] User=natfrp Group=natfrp Type=simple TimeoutStopSec=20 Restart=always RestartSec=5s ExecStart=/home/natfrp/natfrp-service --daemon [Install] WantedBy=multi-user.target

配置完成后,启动并停止一次 natfrp-service 来生成配置文件:

# 请确保您的工作目录正确 cd /home/natfrp/ systemctl start natfrp.service sleep 3 systemctl stop natfrp.service # 确认 config.json 已生成 ls -ls .config/natfrp-service/

修改配置文件,填入访问密钥和远程管理 Key:

# 请确保您的工作目录正确 cd /home/natfrp/ # 生成 KDF 后的远程管理 E2E 密码,复制输出的 Base64 字符串备用 # 注意如果结尾有等号 (=) 出现,请一起复制,它们也是 Base64 的一部分 ./natfrp-service remote-kdf # 编辑配置文件, 以 vim 为例 vim .config/natfrp-service/config.json

找到并修改 token、remote_management、remote_management_key 三项:

{ "token": "SakuraFrp 访问密钥,在管理面板找到", "remote_management": true, "remote_management_key": "刚才成的 Base64 字符串", "log_stdout": true, // 推荐开启 log_stdout 让 Systemd 管理日志 }

启用服务

systemctl enable --now natfrp.service systemctl status natfrp.service # 查看日志,确认看到 "远程管理连接成功" 的输出 journalctl -u natfrp.service -f

最后,打开 远程管理在新窗口打开,连接您的服务器并启用隧道:

# 关于卸载方式

如果您是按照教程安装的,把安装过程中进行的操作反过来进行一遍即可。

# 停用并删除 Unit 文件 systemctl disable --now natfrp.service rm /etc/systemd/system/natfrp.service # 删除用户和 HOME 目录 userdel -r natfrp

系统需求

系统版本:OpenWrt 18 及以上依赖 luci-compat 包(opkg 应该会自动安装)占用 10~30 MiB 硬盘空间(不同架构各不相同)核心服务进程、每个 frpc 进程占用约 30 MiB RAM如果设备 RAM 小于 256 MiB,不推荐使用启动器,请考虑 直接使用 frpc

如果您还在使用旧版本系统,最好先进行更新,或是参考 此处在新窗口打开 进行操作

确认您的路由器架构,然后到 Nyatwork CDN在新窗口打开 下载对应的 IPK 文件

如果您的 OpenWrt 版本较新,可以前往 系统 > 软件包 页面点击 上传软件包 按钮直接进行安装:

如果 LuCI 面板中没有上传软件包按钮,请将软件包通过 SSH 传输到路由器并手动执行命令安装:

opkg install ./luci-app-natfrp_.ipk

安装完成后,退出并重新登录 LuCI 面板,转到 服务 > SakuraFrp 页面并按图示设置:

注意

如果在 启动服务 选择框下方未正确显示服务版本,您下载的架构可能有误 建议先检查下载的架构是否正确、确认 natfrp-service -V 能输出版本号再继续配置

如果一切正常,访问密钥 与 E2E 密码 输入框的内容会被清空,状态会变成绿色的 运行中:

转到 状态 > 系统日志 页面,拉到最下面确认服务登录成功并且连接上了远程管理:

最后,打开 远程管理在新窗口打开,连接您的路由器并启用隧道:

提示

这篇指南以命令行操作 Docker 为例,您应当可以很轻松地将这篇指南中提供的经验迁移到各种 GUI 中

迁移隧道配置

为了提高灵活度,在这篇指南中我们将以 主机网络 模式运行容器。 您此前为 Docker 设置的隧道需要将本地 IP 修改回 127.0.0.1 方可使用。

对于在其他部署方式中本就可以使用的隧道,您不需做出修改。

启动容器

执行下面的指令即可启动:

docker run \ -d \ --network=host \ --restart=on-failure:5 \ --pull=always \ --name=natfrp-service \ natfrp/launcher

如果您卡在了 Pulling from natfrp/launcher,请尝试将最后一行 natfrp/launcher 替换为 registry.cn-hongkong.aliyuncs.com/natfrp/launcher。

如果您遇到了错误 Bind for 0.0.0.0:4101 failed: port is already allocated,请查找本机监听 4101 的程序关闭,或参考 高级用户 替换监听端口。

获取连接信息

执行 docker logs natfrp-service 即可查看容器的日志,您将看到类似下面的回显内容:

============= Service Running ============= WebUI 端口: WebUI 密码: 请使用 https:// 进行连接 ============= Service Running ============= ... ... ... 2038-01-01 00.00.00 Info Service 守护进程初始化完成

请记下其中的 和 处的内容,它们只会显示一次。

您只需本机打开 https://127.0.0.1: 即可访问 WebUI 管理界面。

默认情况下 WebUI 向您连入的所有网络开放,如果您需要访问,可以使用 https://内网IP:, 如果您需要修改监听 IP,请参考 高级用户。

高级用户

如果您需要自行配置,请先阅读 配置文件详解,然后将容器内的 /run/config.json 挂载编辑即可。

# 登录启动器

提示

各平台启动器的操作体验基本一致,本文档将用 Windows WPF 启动器进行演示

安装完成后打开启动器的管理界面。进入 用户信息在新窗口打开 页面,复制 访问密钥 到启动器,点击 登录:

# 创建隧道

请到 SakuraFrp 管理面板 > 隧道列表在新窗口打开 创建隧道以取得最佳使用体验。

本文档提供了 HTTP、RDP、Minecraft 等常见应用的配置指南,如需帮助请查看右上角的 配置指南 列表。

Windows / macOS 启动器的内置创建隧道功能相对简陋,只推荐临时有需求但又没登录面板时使用。

# 启动隧道

在隧道标签中找到您要启用的隧道,点击右上方开关启用。

启用隧道后稍等一会才能连接成功,不要频繁开关隧道。建议打开开关后切换到 日志 标签检查状态。

隧道连接成功后系统会弹出通知,显示隧道连接方式。该通知可以在设置中通过 状态通知 配置项禁用。

如果没有看到通知,请检查系统设置里的通知权限、勿扰模式等设置。

转到日志标签可以复制隧道的连接方式,具体连接方式请参考各个应用 配置指南 中给出的连接方式:

# 删除隧道

将鼠标放到隧道卡片上悬停一会,卡片右上角会出现删除按钮:

点击删除按钮,然后确认操作即可删除隧道:



【本文地址】


今日新闻


推荐新闻


CopyRight 2018-2019 办公设备维修网 版权所有 豫ICP备15022753号-3